すべてのバックアップの表示
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups
- 全体バックアップと増分バックアップが含まれています。 全体バックアップのみを含める場合は、
?fullBackupsOnly
問合せパラメータをtrue
に設定します。 - 成功したバックアップと進行中のバックアップが返されます。 失敗したバックアップと削除されたバックアップを含める場合は、
?includeAll
問合せパラメータをtrue
に設定します。 - 長さが32文字を超えるメモは切り捨てられます。 完了したメモの内容を含める場合は、
?includeCompleteNotes
問合せパラメータをtrue
に設定します。
Oracle Public Cloudでのスケジュールされた自動バックアップ、バックアップの内容およびバックアップが格納される場所の詳細は、『Oracle Java Cloud Serviceの使用』のOracle Java Cloud Serviceインスタンスのバックアップおよびリストアに関する項を参照してください。 Oracle Cloud Machineの場合、OPCMでのOracle Java Cloud Serviceの使用のOracle Java Cloud Serviceインスタンスのバックアップおよびリストアに関する項を参照してください。
注意: 従来のパス/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backupsは推奨されていませんが、近いうちに引き続きサポートされます。 ただし、今後非推奨のURL構造がサポートされなくなった場合に、中断を最小限に抑えるために、新しいパスを使用するようにアプリケーションを移行することをお勧めします。
リクエスト
- identityDomainId
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- serviceId
型:string
必須:true
Oracle Java Cloud Serviceインスタンスの名前。
- fullBackupsOnly
-
型:
boolean
全体バックアップのみを表示する(true
)か、全体バックアップと増分バックアップの両方を表示する(false
)かを指定するフラグ。 デフォルトはfalse
です。- includeAll
型:boolean
成功したもの、進行中のもの、失敗したものおよび削除されたものを含め、すべてのバックアップを表示する(true
)か、成功したか、または進行中のバックアップのみを表示する(false
)かを指定するフラグ。 デフォルトはfalse
です。- includeCompleteNotes
型:boolean
各バックアップの完全な一連のノートを表示する(true
)か、32文字を超えるメモを切り捨てる(false
)かを指定するフラグ。 デフォルトはfalse
です。ヘッダー・パラメータ- X-ID-TENANT-NAME
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
レスポンス
サポートされているメディア・タイプ- application/json
200レスポンスOK 返される可能性のあるその他のHTTPステータス・コードの詳細は、ステータス・コードを参照してください。本文レスポンス本文には、すべてのバックアップに関する情報が含まれます。ルート・スキーマ: viewallbackups-responseレスポンス本文には、すべてのバックアップに関する情報が含まれます。- backupInProgress
-
型:
array
backupInProgress現在処理中のバックアップがあれば、その詳細をグループ化します。 - backups
-
型:
array
backups完了したバックアップをすべてグループ化します。
ネストされたスキーマ: backups- backupCompleteDate
-
型:
string
バックアップが完了した日時。 この属性は処理中のバックアップには無効です。 - backupId
-
型:
string
バックアップID。 特定のバックアップの管理(ダウンロードやアーカイブなど)には、バックアップIDを使用できます。 - backupStartDate
-
型:
string
バックアップを開始した日時。 - databaseIncluded
-
型:
boolean
Oracle Java Cloud Serviceインスタンスのバックアップ操作の一部としてデータベース・バックアップが開始されたかどうかを指定するフラグ。 この属性は、Oracle Public Cloudにのみ適用されます。false
の場合、データベース・バックアップは実行されていません。true
の場合、データベース・バックアップが実行されています。Oracle Cloud Machineでは、この値は常に
false
です。 - dbTag
-
型:
string
RMANタグまたはタイムスタンプ。 この属性は、Oracle Public Cloudにのみ適用されます。この属性は、Oracle Java Cloud Serviceインスタンスのバックアップの一部としてデータベース・バックアップが開始された場合のみ含まれます。 関連するDatabase Cloud Serviceデータベース・デプロイメントが単一インスタンス・データベースをホスティングしている場合、この属性値は特定のデータベース・ファイルがバックアップされていることを示すRMANタグになります。 関連するDatabase Cloud Serviceデータベース・デプロイメントがOracle Real Application Clusters (RAC)データベースをホスティングしている場合、この属性値はデータベース・バックアップのタイムスタンプになります。 どちらの場合も、必要に応じてこの属性値を使用してデータベースをリストアします。 データベース・ファイルのリストアの詳細は、『Oracle Database Cloud Serviceの使用』の特定のバックアップからのリストアまたは特定のPoint in Timeへのリストアに関する項を参照してください。
- deletedOnDate
-
型:
string
バックアップの削除が完了した日時。 この属性は処理中、または現在利用可能なバックアップには無効です。 - expirationDate
-
型:
string
バックアップがストレージから自動的に削除される日時。 値がnull
の場合、バックアップは無期限に保存されるか、手動で削除するまで保存されます。 (オンデマンド・バックアップのkeepForever
がtrue
に設定されている場合、値はnull
です。) - full
-
型:
boolean
これが全体(true
)バックアップか増分(false
)バックアップかを指定するフラグ。 全体バックアップには、サービス・インスタンスの構成データのリストアに必要なすべてのランタイム・アーティファクトが含まれます。 増分バックアップには、前回のスケジュールされた全体バックアップ以降に行われた、すべての仮想マシンの構成データの変更が含まれます。 - href
-
型:
string
バックアップ・リソースのURI。 - initiatedBy
-
型:
string
この操作を開始したユーザー・アカウント。 操作がスケジュール済の自動バックアップの場合、値はscheduled
です。 - jobId
-
型:
string
バックアップのジョブID。 - ローカル
-
型:
boolean
バックアップが、ダウンロードされて管理サーバーのブロック・ストレージにローカルに格納される(true
)か、アーカイブされてリモートに格納される(false
)かを示すフラグ。Oracle Public Cloudでは、リモート・ストレージは指定されたOracle Storage Cloud Serviceコンテナです。
Oracle Cloud Machineでは、リモート・ストレージは指定されたNFSストレージ・ディスクです。
- localCopy
-
型:
boolean
リモート・ストレージにアップロードされたバックアップ用にバックアップのローカル・コピーが保持されるかどうかを示すフラグ。Oracle Public Cloudでは、リモート・ストレージは指定されたOracle Storage Cloud Serviceコンテナです。
Oracle Cloud Machineでは、リモート・ストレージは指定されたNFSストレージ・ディスクです。
- notes
-
型:
string
バックアップに関する追加情報を提供する、自由形式のテキスト。 - serviceComponents
-
型:
array
serviceComponentsサービス・コンポーネントの詳細をグループ化します。 - size
-
型:
string
バックアップのサイズ(MB)。 たとえば、1011.4MB
(バックアップ完了)またはUnknown
(バックアップ処理中)などです。 - sizeInBytes
-
型:
integer
バックアップのバイト単位のサイズ。 - status
-
型:
string
バックアップの状態。 有効な値には、Completed
、Failed
、Deleted
、Backup In Progress
、Upload In Progress
、Download In Progress
、Restore In Progress
、Delete In Progress
があります。 - storageContainer
-
型:
string
この属性はOracle Public Cloudでのみ使用できます。サービス・インスタンスのバックアップが格納される場所。
ネストされたスキーマ: serviceComponentsネストされたスキーマ: servicecomponents- type
-
型:
string
サービス・コンポーネント・タイプ。 有効な値は、JDK
、OTD
、OTD_JDK
またはWLS
です。 - version
-
型:
string
指定されたコンポーネントのソフトウェア・バージョン。 たとえば、WLSの場合は12.1.3.0.5、OTDの場合は11.1.1.9.1、OTD_JDKの場合は1.7.0_91、JDKの場合は1.7.0_91です。
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによってOracle Java Cloud Serviceインスタンスのすべてのバックアップを表示する方法を示しています。
注意: この例のコマンドでは、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインまたはテナント名を問い合せるためのOracle Public CloudまたはOracle Cloud MachineのRESTサーバーです。 Oracle Public CloudまたはOracle Cloud Machineに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。
cURLコマンド
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/backups
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。
HTTP/1.1 200 OK Date: Tue, 07 Mar 2017 19:13:31 GMT Content-Type: application/json
レスポンス本文の例(Oracle Public Cloud)
次の例では、進行中の1つのバックアップを含むJSON形式のレスポンス本文のコンテンツを示しています。
{ "backups":[ { "backupId":"1449332100032", "jobId":"8191", "backupStartDate":"Sat Dec 05 16:15:00 GMT 2016", "backupCompleteDate":"Sat Dec 05 17:36:18 GMT 2016", "expirationDate":"Mon Jan 04 16:15:00 GMT 2017", "initiatedBy":"scheduled", "full":true, "local":false, "localCopy":true, "databaseIncluded":true, "size":"15.8MB", "sizeInBytes":16557866, "dbTag":"TAG20151205T163004", "status":"Completed", "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups" "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1449332100032", "serviceComponents":[ { "type":"OTD_JDK", "version":"1.7.0_91" }, { "type":"JDK", "version":"1.7.0_91" }, { "type":"WLS", "version":"12.1.3.0.5" }, { "type":"OTD", "version":"11.1.1.9.1" }], "notes":"Automated backup" }, { "backupId":"1449340039298", "jobId":"8213", "backupStartDate":"Sat Dec 05 18:27:19 GMT 2016", "backupCompleteDate":"Sat Dec 05 18:29:53 GMT 2016", "expirationDate":"Mon Jan 04 18:27:19 GMT 2017", "initiatedBy":"username", "full":true, "local":false, "localCopy":true, "databaseIncluded":false, "size":"16MB", "sizeInBytes":16792928, "status":"Completed", "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups" "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1449340039298", "serviceComponents":[ { "type":"OTD_JDK", "version":"1.7.0_91" }, { "type":"JDK", "version":"1.7.0_91" }, { "type":"WLS", "version":"12.1.3.0.5" }, { "type":"OTD", "version":"11.1.1.9.1" }] }, {...} ], "backupInProgress":{ "backupId":"1449346810790", "jobId":"8221", "backupStartDate":"Sat Dec 05 20:20:10 GMT 2016", "expirationDate":"Mon Jan 04 20:20:10 GMT 2017", "initiatedBy":"username", "full":true, "local":true, "localCopy":false, "databaseIncluded":true, "size":"Unknown", "sizeInBytes":0, "dbTag":"unavailable", "status":"Backup In Progress", "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups" "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/144934681079 0", "notes":"On-demand full with database..." } }
レスポンス本文の例(Oracle Cloud Machine)
次の例では、進行中の1つのバックアップを含むJSON形式のレスポンス本文のコンテンツを示しています。
{ "backups":[ { "backupId":"1449223500059", "jobId":"6270", "backupStartDate":"Fri Dec 04 10:05:00 GMT 2015", "backupCompleteDate":"Fri Dec 04 10:10:06 GMT 2015", "expirationDate":"Sat Jan 09 10:05:00 GMT 2016", "initiatedBy":"scheduled", "full":true, "local":false, "localCopy":true, "databaseIncluded":false, "size":"1697.4MB", "sizeInBytes":1779870512, "status":"Completed", "href":"https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/myTenantName\/ExampleInstance\/backups\/1449223500059", "serviceComponents":[ { "type":"OTD", "version":"11.1.1.9.1" }, { "type":"OTD_JDK", "version":"1.7.0_91" }, { "type":"JDK", "version":"1.7.0_91" }, { "type":"WLS", "version":"12.1.3.0.5" } ], "notes":"Automated backup" }, {...}, { "backupId":"1450995000073", "jobId":"7027", "backupStartDate":"Thu Dec 24 22:10:00 GMT 2015", "backupCompleteDate":"Thu Dec 24 22:12:40 GMT 2015", "expirationDate":"Sat Jan 23 22:10:00 GMT 2016", "initiatedBy":"scheduled", "full":false, "local":false, "localCopy":true, "databaseIncluded":false, "size":"149.7MB", "sizeInBytes":156982572, "status":"Completed", "href":"https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/myTenantName\/ExampleInstance\/backups\/1450995000073", "serviceComponents":[ { "type":"OTD", "version":"11.1.1.9.1" }, { "type":"OTD_JDK", "version":"1.7.0_91" }, { "type":"JDK", "version":"1.7.0_91" }, { "type":"WLS", "version":"12.1.3.0.5" } ], "notes":"Automated backup" }], "backupInProgress": { "backupId":"1450996752252", "jobId":"10029", "backupStartDate":"Thu Dec 24 22:39:12 GMT 2015", "expirationDate":"Sat Jan 23 22:39:12 GMT 2016", "initiatedBy":"username", "full":true, "local":true, "localCopy":false, "databaseIncluded":false, "size":"149.7MB", "sizeInBytes":156979772, "status":"Backup In Progress", "href":"https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/myTenantName\/ExampleInstance\/backups\/1450996752252", "notes":"On-demand full backup..." } }